/*
 * Copyright (c) 2013, 2022, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package org.graalvm.visualizer.data.services;

import jdk.graal.compiler.graphio.parsing.model.InputGraph;
import jdk.graal.compiler.graphio.parsing.model.InputNode;

import java.util.Collection;

/**
 * Basic manipulation / navigation services in graph
 */
public interface GraphSelections {
    /**
     * @return the represented graph instance
     */
    public InputGraph getGraph();

    /**
     * Returns nodes selected in the graph
     *
     * @return selected nodes
     */
    public Collection<InputNode> getSelectedNodes();

    /**
     * Selects specified nodes
     *
     * @param nodes nodes to select
     */
    public void setSelectedNodes(Collection<InputNode> nodes);

    /**
     * Extracts a set of nodes. The graph view will narrow to show the nodes
     * passed as a parameter
     *
     * @param nodes nodes to show
     */
    public void extractNodes(Collection<InputNode> nodes);

    /**
     * Scrolls so that specified nodes are visible in the graph.
     *
     * @param nodes nodes to show
     */
    public void scrollToVisible(Collection<InputNode> nodes);
}
